home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr09 / cfr111.zip / CFR.HLP < prev    next >
Text File  |  1993-06-09  |  17KB  |  416 lines
  1.  
  2.                             CFR HELP INDEX                 Page #
  3.        ============================================================
  4.           What this Program Can Do  ........................   2
  5.           Warning  .........................................   3
  6.           Introduction  ....................................   4
  7.           Program Default Screen ...........................   5
  8.           Cross Reference Screen  ..........................   8
  9.           What if PAF Information is Different .............   8
  10.           Need TO Add Screen  ..............................   9
  11.           LOG File  ........................................   9
  12.           CFR.DEF File  ....................................  10
  13.           How Program Works  ...............................  19
  14.           What If Errors Occur  ............................  21
  15.  
  16.                                   Page 1
  17.  
  18.  
  19.  
  20.  
  21. WHAT this PROGRAM CAN DO:
  22.  
  23.           The purpose of this program is to allow a much more convenient
  24.      method to find differences and make changes for the data files created
  25.      by the Personal Ancestral File program (PAF).  PAF is a copyrighted
  26.      program of The Corporation of the President of The Church of Jesus
  27.      Christ of Latter-day Saints.  I will refer to this program as PAF from
  28.      this point on.
  29.  
  30.           This program allows the computer to do much of the work of
  31.      comparing two different Genealogical data bases.  The amount of
  32.      information compared within both data bases is determined by the
  33.      operator.  The choices are; 1. Direct line, ancestors only, 2. All
  34.      lines, Ancestors & Decedents except multiple marriages.  If the
  35.      individual, marriage or notes are different the differences are
  36.  
  37.                                   Page 2
  38.  
  39.  
  40.      [ displayed on the screen (optional see CFR.DEF file) ] and printed in
  41.      a document file or printer.
  42.           To compare multiple marriages rerun the program using the nonancestral
  43.      spouse as the first individual.
  44.           This program does not allow the use of external note file pointed
  45.      to by the ID# Record entry. (See PAF documentation)
  46.  
  47. WARNING:
  48.      TRY NOT TO DO THIS!!! use Ctrl-Break or turn the power off
  49.           with in the program this may results in loss of your
  50.           data files.  The program will not process a Ctrl-Break
  51.           until the program is at a safe point.
  52.  
  53.      INSTEAD DO THIS!!!  If you want to stop use Function Key 3
  54.           as provided within the program.
  55.  
  56.                                   Page 3
  57.  
  58.  
  59.      I DO Not take responsibility for any data LOSS caused by the use of
  60.         this program!  I have made a sincere effort to eliminate these type
  61.         of error.  But the possibility of errors does exist.
  62.  
  63. INTRODUCTION:
  64.  
  65.           My brother and I decided to provide our brothers and sisters with
  66.      all the genealogical information we have assembled for our family.  We
  67.      became very frustrated trying to compare and combine our two data
  68.      bases and keep them up dated as well as trying to keep the rest of the
  69.      family updated with all the changes.  With the current PAF software it
  70.      became necessary to reprint almost all the information and
  71.      redistribute it to the family.  This program allows us to only reprint
  72.      the pages that have information that is changed and not just because
  73.      one of the RIN's or MRIN's numbers have changed.
  74.                                   Page 4
  75.  
  76.  
  77.  
  78. PROGRAM DEFAULT screen:
  79.      1. Specify SOURCE #1 drive:[path] :
  80.         Source #1 is the data file that you originally had.  This option
  81.         allows you to change the drive and/or sub-directory from which the
  82.         SOURCE #1 information comes from and which.  The default for this
  83.         value in the CFR.DEF file.
  84.  
  85.      2. Specify SOURCE #2 drive:[path] :
  86.         Source #2 is the data file that you just received and want to check
  87.         for differences.  This option allows you to change the drive and/or
  88.         sub-directory from which the information to be compared with the
  89.         SOURCE #1 data files.  The default for this value in the CFR.DEF
  90.         file.
  91.  
  92.      For 1 & 2:  Acceptable examples are as follows.  "c",  "c:",
  93.         "c:\GEN",  "c:\GEN\"
  94.                                   Page 5
  95.  
  96.  
  97.      3. Log File ........ <NUL>,<PRN>,<drive:[path]CFRLOG> :
  98.         This option is very useful for documenting any changes you need to
  99.         make to the SOURCE #1 data base.  These differences would be any
  100.         Individual, Marriage or Notes that need to be changed or added.  It
  101.         also includes RIN, MRIN and the things that are different.  In the
  102.         case of notes that need to be added they need to be edited using
  103.         PAF note editor.  The default for this value is in the CFR.DEF
  104.         file.
  105.  
  106.      4. First Individual Source #1 & #2 ............ RIN # :
  107.         This is the RIN's numbers for the individual that the comparison
  108.         process start with.  You must use PAF to manually find this
  109.         individual in both data bases and enter the RIN's here.  See
  110.         Comparison method to determine how comparison goes form here.
  111.  
  112.                                   Page 6
  113.  
  114.  
  115.  
  116.      5. Comparison method ... :
  117.         This option allows the user to compare and SOURCE #2 all or just
  118.         one line in there ancestry.  The choices are; Ancestors, All
  119.         (Ancestors and Decedents of the First Individual).  The starting
  120.         person is defined by the person in the above option.  Note that the
  121.         individuals spouses lines are not compared in the Direct line
  122.         option.
  123.  
  124.      6. Continue:
  125.         This is the option that is used to proceed with execution of the
  126.         program
  127.  
  128.      7. Quit:
  129.         No explanation necessary
  130.  
  131.                                   Page 7
  132.  
  133.  
  134.  
  135. CROSS REFERENCE screen:
  136.  
  137.           In some cases enough information is not available for the program
  138.      to determine if a person or marriage is the same.  In these cases it
  139.      displays all the available information about the person or marriage
  140.      and a pop up screen will ask if they are the same and show you the
  141.      possibilities you have to chose form.  You tell the computer they are
  142.      the same by pressing a "y" or "n".
  143.  
  144. WHAT if PAF INFORMATION is DIFFERENT:
  145.           A switch in the CFR.DEF file determines if the program displays
  146.      every difference on the screen.  Aut0='N' will display each individual
  147.      and marriage that is different on the screen.  Pressing any key will
  148.      continue program execution.  Aut0='Y' will disable this option.  In
  149.      ether case more detailed information will be written to the log file.
  150.                                   Page 8
  151.  
  152.  
  153.  
  154. NEED TO ADD screen:
  155.  
  156.           In the case where an individual, marriage or note is not present
  157.      in the SOURCE #1 file a pop up question will tell you that you need to
  158.      add the person, individual or note.  You tell the computer it okay to
  159.      progress by pressing any key.  This will never happen if Aut0='Y' they
  160.      are automaticly added.
  161.  
  162. LOG file:
  163.           A log file has been added for convenience.  This file tell of all
  164.      the difference the program found between the two files.  It also
  165.      contains information about each data file.  The total number of
  166.      individuals, marriages compared.  It lists all the individuals,
  167.      marriages that need to be added.  The order that information is
  168.      presented is the same order that it was executed.
  169.  
  170.                                   Page 9
  171.  
  172.  
  173. CFR.DEF file:
  174.      "This file is the default file for 640K machine"
  175.      MAX NAME SIZE=7709
  176.      MAX INDIVIDUAL SIZE = 32768
  177.      MAX MARRIAGE SIZE = 15000
  178.      NUMBER OF NOTE LINES = 100
  179.      NUMBER OF HELP LINES = 402
  180.      PATH1$=C:\GEN\DATA\
  181.      PATH2$=C:\GEN\TEMP\
  182.      AUT0 = Y
  183.      LOG FILE=C:\GEN\MYPROG\COMPARE.LOG
  184.      PRINT FAMILY TO DOC=N
  185.      DISPLAY FREE MEMORY=Y
  186.      STACK HISTORY=N
  187.      LINES TO COMPARE=Ancestors
  188.      SOURCE#1 FIRST RIN #=1
  189.                                   Page 10
  190.  
  191.  
  192.      SOURCE#2 FIRST RIN #=1
  193.      BACKGROUND = Blue
  194.      BORDER = Cyan
  195.      TEXT = White
  196.      TITLES = Magenta
  197.      ERROR=Red
  198.      CHOICE = Black
  199.  
  200.                                   Page 11
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.      MAX NAME SIZE:
  212.         Is the maximum number of names that can be in the SOURCE #1 in the
  213.         NAME2.DAT file plus new names added form SOURCE #2.  The value of
  214.         this will very with computer configuration.  But must be less than
  215.         7709 (uses 17 Bytes/name).
  216.  
  217.      MAX INDIVIDUAL SIZE:
  218.         The maximum number of individuals that can be in the SOURCE #1 in
  219.         the INDIV2.DAT files.  The value of this will very with computer
  220.         configuration.  But must be less than 32,767.
  221.  
  222.      MAX MARRIAGE SIZE:
  223.         The maximum number of marriages that can be in the SOURCE #1 in the
  224.         MARR2.DAT files.  The value of this will very with computer
  225.         configuration.  But must be less than 32,767.
  226.  
  227.                                   Page 12
  228.  
  229.  
  230.      NUMBER OF NOTE LINES:
  231.         This the maximum number of lines that can be displayed for any
  232.         individuals note.  Decreasing this will free up memory for other
  233.         things.
  234.      NUMBER OF HELP LINES:
  235.         This the maximum number of lines that can be displayed when F1 is
  236.         pressed.  Decreasing the number of help lines to 1 will free up the
  237.         memory used by this file thus freing memory for other things.
  238.      PATH1$:
  239.         Specify SOURCE #1 drive:[path] :
  240.         Source #1 is the data file that you originally had.  This option
  241.         allows you to change the drive and/or sub-directory from which the
  242.         SOURCE #1 information comes from and which.  The default for this
  243.         value in the CFR.DEF file.
  244.  
  245.                                   Page 13
  246.  
  247.  
  248.  
  249.      PATH2$:
  250.         Specify SOURCE #2 drive:[path] :
  251.         Source #2 is the data file that you just received and want to check
  252.         for differences.  This option allows you to change the drive and/or
  253.         sub-directory from which the information to be compared with the
  254.         SOURCE #1 data files.  The default for this value in the CFR.DEF
  255.         file.
  256.      AUT0:
  257.         Y = Differences are not displayed on the screen
  258.         N = Differences are displayed on the screen
  259.  
  260.      LOG FILE:
  261.         <NUL>,<PRN>,<drive:[path]CFRLOG> :
  262.         This option is very useful for documenting any changes you need to
  263.         make to the SOURCE #1 data base.  These differences would be
  264.  
  265.                                   Page 14
  266.  
  267.  
  268.         any Individual, Marriage or Notes that need to be changed or added.
  269.         It also includes RIN, MRIN and the things that are different.  In
  270.         the case of notes that need to be added they need to be edited
  271.         using PAF note editor.  The default for this value is in the
  272.         CFR.DEF file.
  273.  
  274.      PRINT FAMILY TO DOC:
  275.         Used for debugging the program.  Prints all the members of each
  276.         family into the Log file.
  277.  
  278.      DISPLAY FREE MEMORY:
  279.         Top left hand corner will show number of bytes left  for entries
  280.         from NAME2.DAT then the rest of space for all other arrays.  Also
  281.         in the top right hand corner the average length of all name entries
  282.         will be displayed.  "Y" or "N" or "y"  or "n"
  283.  
  284.                                   Page 15
  285.  
  286.  
  287.      STACK HISTORY:
  288.         Used for debugging the program.  Prints all marriages as they are
  289.         pushed and poped form the stack into the 'stack.his' file.
  290.      LINES TO COMPARE:
  291.         Ancestors(Direct line only):
  292.         This option allows the user to compare and SOURCE #2 all or just
  293.         one line in there ancestry.  The starting person is defined by the
  294.         person in the above option.  Note that the and spouse of the first
  295.         Individual and spouses of children are not compared in the Direct
  296.         line option. !!! Ancestors only works in this Version.!!!
  297.      SOURCE#x FIRST RIN #S:
  298.         This is the RIN # for the SOURCE #1 and SOURCE #2 Individual that
  299.         the comparison process start with.  In the Direct line only mode
  300.         comparison goes back from this individual.  Where as in the All
  301.         Lines mode comparison goes up and down all lines from here.
  302.  
  303.                                     Page 16
  304.  
  305.  
  306.      BACKGROUND:  Color of the background.  See following chart.
  307.  
  308.      BORDER:   Color of the screen border.  See following chart.
  309.  
  310.      TEXT:  Color of the Text.  See following chart.
  311.  
  312.      TITLES:  Color of the Title.  See following chart.
  313.  
  314.      ERROR:  Color of the Error message.  See following chart.
  315.  
  316.      CHOICE:  Color of the prompt requiring a response. See chart.
  317.  
  318.                                   Page 17
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                      Valid Colors
  328.  
  329.             ================================
  330.                Black,         Gray
  331.                Blue,          Bright Blue
  332.                Green,         Bright Green
  333.                Cyan,          Bright Cyan
  334.                Red,           Bright Red
  335.                Magenta,       Bright Magenta
  336.                Brown,         Yellow
  337.                White,         Bright White
  338.  
  339.  
  340.  
  341.                                   Page 18
  342.  
  343.  
  344. HOW the PROGRAM WORKS:
  345.  
  346.              Direct line only method is as follows.  A individual is chosen
  347.         his parents marriage is compared and all of the siblings are
  348.         compared at this time also.  The parents are then placed in the
  349.         position of the first individual and the cycle is repeated again.
  350.         Progression goes from Child to Father up the paternal line until
  351.         the end of the line is reached.  Then it steps back to mother and
  352.         up her paternal line and so forth.  Children's spouses and their
  353.         lines are not compared.
  354.  
  355.              All lines is similar to direct line only except the lines of
  356.         the children's spouses are also put in to the compare sequence.
  357.  
  358.                                   Page 19
  359.  
  360.  
  361.  
  362.  
  363.         The maximum number of Names is defined by MAX NAME  SIZE in
  364.         CFR.DEF.  Note program will stop if string memory is used up.  The
  365.         maximum number of Individuals is MAX SIZE in CFR.DEF.  The maximum
  366.         number of Marriages is MAX SIZE/2 in CFR.DEF.
  367.  
  368.              It should also be noted that the base RIN is assumed to be 0.
  369.         This is also the case with the base MRIN is assumed to be 0 as well
  370.         as the Volume number is also 0.
  371.  
  372.              Note that if a birthday is not present the Christening Date
  373.         then the Death date and finally the Burial date is used for cross
  374.         referencing.
  375.  
  376.              The program doesn't differentiate between names that are upper
  377.         case and those and those that are lower case.
  378.  
  379.                                   Page 20
  380.  
  381.  
  382. WHAT IF ERRORS OCCUR:
  383.  
  384.      Out of memory errors as you start the program:
  385.         If you start the program and get an out of memory error try the
  386.         following;  1. Reduce the size of 'MAX NAME SIZE', 'MAX INDIVIDUAL
  387.         SIZE' 'MAX MARRIAGE SIZE' they still must fit requirements defined
  388.         above.  2. Reduce the 'NUMBER OF NOTE LINES' this may make the
  389.         program crash if you have a note for an individual more than the
  390.         number you defined.  3. Disable th help function by reducing
  391.         'NUMBER OF HELP LINES' this make the program crash if you press F1.
  392.         Start with step 1 and progress until the program will run.
  393.  
  394.      File not found error or invalid path statement:
  395.         This will occur if you have defined the 'PATH1$' or 'PATH2$'
  396.         incorrectly.  It could also happen if the CFR.DEF is not in the
  397.                                   Page 21
  398.  
  399.  
  400.  
  401.       default directory.  Ether change the default directory or execute the
  402.         program as "CFR d:\correct path\CFR.DEF".  Note this allows you to
  403.         have several default file and you can choose which you can run
  404.         with.
  405.  
  406.           I would be interested if anyone finds errors in this program.
  407.      Please send me a copy of the log file, and the two sets of PAF data
  408.      files and the 'STACK.HIS'.  Then I possibly can recreate the error and
  409.      correct it.
  410.  
  411.                                Ernest Esplin
  412.                                131 Briarwood
  413.                            Versailles Ky.  40383
  414.  
  415.                                   Page 22
  416.